Skip to main content

VolumesComponent

VolumesComponent API

VolumesComponent.registerDefaultVolumeColorResolvers
VolumesComponent.registerDefaultVolumeColorResolvers(): void

Registers default volume color resolvers for candle, line and bar charts

Returns
void
VolumesComponent.setShowVolumesSeparatly
VolumesComponent.setShowVolumesSeparatly(separate: boolean): void

Sets whether the volumes should be shown separately or not.

Parameters
separate: boolean
- A boolean value indicating whether the volumes should be shown separately or not.
Returns
void
VolumesComponent.doDeactivate
VolumesComponent.doDeactivate(): void

This method deactivates the current component by calling the superclass doDeactivate method and setting the visibility of the component to false.

Returns
void
VolumesComponent.registerVolumeColorResolver
VolumesComponent.registerVolumeColorResolver(chartType: keyof BarTypes, resolver: VolumeColorResolver): void

You can use this method to determine volumes' color for specified chart type.

Parameters
chartType: keyof BarTypes
resolver: VolumeColorResolver
Returns
void
VolumesComponent.setVisible
VolumesComponent.setVisible(visible: boolean): void

Sets the visibility of the volumes component and updates the canvas accordingly.

Parameters
visible: boolean
- Whether the volumes component should be visible or not. Default is true.
Returns
void
VolumesComponent.syncVolumesDynamicObject
VolumesComponent.syncVolumesDynamicObject(): void

Returns
void
;